Non TMF Biz Api

/SSNSearch [POST]

This Operation is to lookup for the account based on Social Security Number.

Process sequence diagram

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/nontmf-biz/v1/{businessId}/SSNSearch

URL PARAMS

Header

s

Body

The request body contains an entity corresponding to the request below.

{
    "RequestType": "EncryptedSSNLookup",
    "SourceSystem": "Digital",
    "EncryptedSSN": "QxA9FdX9s//LPht3q9mreNSefeKAc10cG4aBt5d+Cxs="
}

Definitions

Each of the response parameters is detailed.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

success response will be returned from salesforce with 200 Ok HTTP status

{
    "status": 200,
    "message": "SSN already exists.",
    "BANCAN": "23636033-23637361"
}

Definitions

Each of the response parameters is detailed.

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "SSN is null (or) invalid encrypted SSN.",
      "description" : "SSN is null (or) invalid encrypted SSN."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "A Site with the xxx in your X-Authentication Header cannot be found. Please check your UserName",
      "description" : "A Site with the xxx in your X-Authentication Header cannot be found. Please check your UserName"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "SSN not found.",
      "description" : "SSN not found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/customer"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /customer for Business Id: xxxx not implemented"
    }]
  }

Administration and data management

In this section you define all the transformations, temporary and final repositories of the data within the method flow.

Note: Request will route to this flow based on the op value if its idCheck it will route to Id Check Flow if their value is docVerification then it will route to Doc verification flow

Transformation Request

In this section the matrix of all the data transformations that is carried out within the service is defined.

Transformation Response

In this section the matrix of all the data transformations that is carried out within the service is defined.

Services dependencies

This section defines all the connections to the web services and the methods that are used within the method.

sfdc-sys